Skip to main content

Account Setup

Before you begin, ensure that you complete the necessary setup and configuration tasks for your Content Innovation Cloud accounts:

  1. Getting a subscription
  2. Creating a service account
  3. Assigning user groups
  4. Registering an external client
  5. Assigning user roles

Getting a Subscription​

To configure user permissions for the Knowledge Enrichment APIs, you must have access to an environment with the appropriate API, such as Context API or the Data Curation API. You can check the subscriptions in an environment from the Content Innovation Cloud Administration Portal. For more information, see Subscriptions.

Creating a Service Account​

Since the APIs are hosted by Hyland, the endpoints for access must be provided by Hyland. To utilize the endpoints, you must have a service account registered in the environment to be used. An initial administration account for Content Innovation Cloud must be provided by Hyland, but afterward further accounts can be configured by following the information in Metadata for SAML Identity Providers.

Creating a User Group​

Create a user group that has either the Data Curation User or the Context API User role assigned to it. You can check for existing user groups first by logging into the CIC Administration Portal. See Assigning User Groups to Roles for more information.

If there are no user groups then you can create a new one. For more information, see Creating a User Group.

Registering an External Client​

External applications can call the Knowledge Enrichment APIs for custom integrations. To allow an external application to request access tokens for Knowledge Enrichment APIs, an administrator must register the external application as a client. See the section on Registering an External Application for more information.

Note: The Client ID and its secret are displayed only once. It is recommended that you save them for future use.

Scopes for External Applications​

environment_authorization is one of the required scopes for external applications. For details on the required scopes, see Scopes for External Applications. When configuring the allowed scopes for the Data Curation API, select cin-data-curation-api in the Application field in the Content Innovation Cloud Administration portal.

Resetting the Secret for an External Application​

Follow the steps listed in the topic, Resetting the Secret for an External Application to reset the secret.

Assigning User Roles​

See the topic, Assigning User Groups to Roles for information.

Once you have completed configuring the above-mentioned requirements, see Authentication.